feat: include called service URI in StatusRuntimeException description#652
Closed
He-Pin wants to merge 1 commit intoapache:mainfrom
Closed
feat: include called service URI in StatusRuntimeException description#652He-Pin wants to merge 1 commit intoapache:mainfrom
He-Pin wants to merge 1 commit intoapache:mainfrom
Conversation
Port upstream akka/akka-grpc@82e0413e. Add the request URI to the StatusRuntimeException description via augmentDescription so that callers can easily identify which service caused the failure. Add MiMa filter for the changed responseToSource signature (internal API). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
When a gRPC call fails, the
StatusRuntimeExceptiondescription only contained the raw gRPC status message. In systems with multiple services, it was difficult to tell which service caused the failure, particularly for generic error codes likeUNAVAILABLEorCANCELLED.Modification
requestUri: Urias a first parameter to the internalPekkoHttpClientUtils.responseToSource,mapToStatusException, andparseResponseStatusmethods"When calling rpc service: <URI>"to the exception description viaStatus.augmentDescription()in both branches ofmapToStatusException(the "no grpc-status" and "non-zero status code" paths)PekkoHttpClientUtilsSpectests to passrequestUrito allresponseToSourcecallsPekkoGrpcScalaClientTesterinterop test assertion to usestartsWith(since the description now has an appended URI suffix)responseToSourcesignatureResult
Error messages now include the called service URI, making debugging significantly easier:
References